Operation Directory.SuggestEntries (Get suggested directory entries)

In component org.nuxeo.ecm.core.automation.features.operations

Description

Get the entries suggestions of a directory. This is returning a blob containing a serialized JSON array. Prefix parameter is used to filter the entries.

Operation id	Directory.SuggestEntries
Category	Services
Label	Get suggested directory entries
Requires
Since

Parameters

Name	Type	Required
directoryName	string	yes
absoluteLabelSeparator	string	no
canSelectParent	boolean	no
caseSensitive	boolean	no
contains	boolean	no
dbl10n	boolean	no
displayObsoleteEntries	boolean	no
filterParent	boolean	no
filters	properties	no
keySeparator	string	no
labelFieldName	string	no
lang	string	no
limit	int	no
localize	boolean	no
searchTerm	string	no

Signature

Inputs	void
Outputs	blob

Implementation Information

Implementation Class	Class: org.nuxeo.ecm.automation.core.operations.services.directory.SuggestDirectoryEntries
Contributing Component	org.nuxeo.ecm.core.automation.features.operations

JSON Definition

{
  "id" : "Directory.SuggestEntries",
  "label" : "Get suggested directory entries",
  "category" : "Services",
  "requires" : null,
  "description" : "Get the entries suggestions of a directory. This is returning a blob containing a serialized JSON array. Prefix parameter is used to filter the entries.",
  "url" : "Directory.SuggestEntries",
  "signature" : [ "void", "blob" ],
  "params" : [ {
    "name" : "directoryName",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "absoluteLabelSeparator",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "canSelectParent",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "caseSensitive",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "contains",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "dbl10n",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "displayObsoleteEntries",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "filterParent",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "filters",
    "description" : null,
    "type" : "properties",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "keySeparator",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "labelFieldName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "lang",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "limit",
    "description" : null,
    "type" : "int",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "localize",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "searchTerm",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}